home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / chbgv.z / chbgv
Encoding:
Text File  |  2002-10-03  |  6.1 KB  |  199 lines

  1.  
  2.  
  3.  
  4. CCCCHHHHBBBBGGGGVVVV((((3333SSSS))))                                                            CCCCHHHHBBBBGGGGVVVV((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CHBGV - compute all the eigenvalues, and optionally, the eigenvectors of
  10.      a complex generalized Hermitian-definite banded eigenproblem, of the form
  11.      A*x=(lambda)*B*x
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE CHBGV( JOBZ, UPLO, N, KA, KB, AB, LDAB, BB, LDBB, W, Z, LDZ,
  15.                        WORK, RWORK, INFO )
  16.  
  17.          CHARACTER     JOBZ, UPLO
  18.  
  19.          INTEGER       INFO, KA, KB, LDAB, LDBB, LDZ, N
  20.  
  21.          REAL          RWORK( * ), W( * )
  22.  
  23.          COMPLEX       AB( LDAB, * ), BB( LDBB, * ), WORK( * ), Z( LDZ, * )
  24.  
  25. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  26.      These routines are part of the SCSL Scientific Library and can be loaded
  27.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  28.      directs the linker to use the multi-processor version of the library.
  29.  
  30.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  31.      4 bytes (32 bits). Another version of SCSL is available in which integers
  32.      are 8 bytes (64 bits).  This version allows the user access to larger
  33.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  34.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  35.      only one of the two versions; 4-byte integer and 8-byte integer library
  36.      calls cannot be mixed.
  37.  
  38. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  39.      CHBGV computes all the eigenvalues, and optionally, the eigenvectors of a
  40.      complex generalized Hermitian-definite banded eigenproblem, of the form
  41.      A*x=(lambda)*B*x. Here A and B are assumed to be Hermitian and banded,
  42.      and B is also positive definite.
  43.  
  44.  
  45. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  46.      JOBZ    (input) CHARACTER*1
  47.              = 'N':  Compute eigenvalues only;
  48.              = 'V':  Compute eigenvalues and eigenvectors.
  49.  
  50.      UPLO    (input) CHARACTER*1
  51.              = 'U':  Upper triangles of A and B are stored;
  52.              = 'L':  Lower triangles of A and B are stored.
  53.  
  54.      N       (input) INTEGER
  55.              The order of the matrices A and B.  N >= 0.
  56.  
  57.      KA      (input) INTEGER
  58.              The number of superdiagonals of the matrix A if UPLO = 'U', or
  59.              the number of subdiagonals if UPLO = 'L'. KA >= 0.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCHHHHBBBBGGGGVVVV((((3333SSSS))))                                                            CCCCHHHHBBBBGGGGVVVV((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      KB      (input) INTEGER
  75.              The number of superdiagonals of the matrix B if UPLO = 'U', or
  76.              the number of subdiagonals if UPLO = 'L'. KB >= 0.
  77.  
  78.      AB      (input/output) COMPLEX array, dimension (LDAB, N)
  79.              On entry, the upper or lower triangle of the Hermitian band
  80.              matrix A, stored in the first ka+1 rows of the array.  The j-th
  81.              column of A is stored in the j-th column of the array AB as
  82.              follows:  if UPLO = 'U', AB(ka+1+i-j,j) = A(i,j) for max(1,j-
  83.              ka)<=i<=j; if UPLO = 'L', AB(1+i-j,j)    = A(i,j) for
  84.              j<=i<=min(n,j+ka).
  85.  
  86.              On exit, the contents of AB are destroyed.
  87.  
  88.      LDAB    (input) INTEGER
  89.              The leading dimension of the array AB.  LDAB >= KA+1.
  90.  
  91.      BB      (input/output) COMPLEX array, dimension (LDBB, N)
  92.              On entry, the upper or lower triangle of the Hermitian band
  93.              matrix B, stored in the first kb+1 rows of the array.  The j-th
  94.              column of B is stored in the j-th column of the array BB as
  95.              follows:  if UPLO = 'U', BB(kb+1+i-j,j) = B(i,j) for max(1,j-
  96.              kb)<=i<=j; if UPLO = 'L', BB(1+i-j,j)    = B(i,j) for
  97.              j<=i<=min(n,j+kb).
  98.  
  99.              On exit, the factor S from the split Cholesky factorization B =
  100.              S**H*S, as returned by CPBSTF.
  101.  
  102.      LDBB    (input) INTEGER
  103.              The leading dimension of the array BB.  LDBB >= KB+1.
  104.  
  105.      W       (output) REAL array, dimension (N)
  106.              If INFO = 0, the eigenvalues in ascending order.
  107.  
  108.      Z       (output) COMPLEX array, dimension (LDZ, N)
  109.              If JOBZ = 'V', then if INFO = 0, Z contains the matrix Z of
  110.              eigenvectors, with the i-th column of Z holding the eigenvector
  111.              associated with W(i). The eigenvectors are normalized so that
  112.              Z**H*B*Z = I.  If JOBZ = 'N', then Z is not referenced.
  113.  
  114.      LDZ     (input) INTEGER
  115.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  116.              'V', LDZ >= N.
  117.  
  118.      WORK    (workspace) COMPLEX array, dimension (N)
  119.  
  120.      RWORK   (workspace) REAL array, dimension (3*N)
  121.  
  122.      INFO    (output) INTEGER
  123.              = 0:  successful exit
  124.              < 0:  if INFO = -i, the i-th argument had an illegal value
  125.              > 0:  if INFO = i, and i is:
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCHHHHBBBBGGGGVVVV((((3333SSSS))))                                                            CCCCHHHHBBBBGGGGVVVV((((3333SSSS))))
  137.  
  138.  
  139.  
  140.              <= N:  the algorithm failed to converge:  i off-diagonal elements
  141.              of an intermediate tridiagonal form did not converge to zero; >
  142.              N:   if INFO = N + i, for 1 <= i <= N, then CPBSTF
  143.              returned INFO = i: B is not positive definite.  The factorization
  144.              of B could not be completed and no eigenvalues or eigenvectors
  145.              were computed.
  146.  
  147. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  148.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  149.  
  150.      This man page is available only online.
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.